/*-
 * PhonebookManager.java
 *
 * $LastChangedBy:  $
 * $LastChangedRevision:  $
 * $LastChangedDate:  $
 * $HeadURL: $
 *
 * Copyright (c) 2008, Stein Gunnar Bakkeby
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Stein Gunnar Bakkeby nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.googlecode.attention;

import java.rmi.Remote;
import java.rmi.RemoteException;


public interface PhonebookManager extends Remote {

  /**
   * This will try to retrieve all phonebook entries by making two calls to the
   * mobile. The first call will retrieve the phonebook memory index range,
   * while the second will retrieve the actual phonebook entries at the
   * preferred memory location. In case of error this method should return an
   * empty PhonebookEntry array. Note that 
   * 
   * @return Phonebook entries or empty array in case of error.
   * @throws RemoteException RMI
   */
  PhonebookEntry[] getPhonebookEntries() throws RemoteException;
  
  /**
   * This will try to retrieve the phonebook entry at a given index. If there
   * is no entry at the given index or a timeout occurs then null will be
   * returned.
   * 
   * @param memoryIndex The memory index to retrieve information from
   * @return The phonebook entry or null in case of error
   * @throws RemoteException RMI
   */
  PhonebookEntry getPhonebookEntry(final int memoryIndex) throws RemoteException;
  
  /**
   * This will try to write a phonebook entry to the preferred memory location,
   * overwriting previous entries as necessary. 
   * 
   * @param entry The phonebook entry to write
   * @return True if the entry was successfully written, false otherwise
   * @throws RemoteException RMI
   */
  boolean writePhonebookEntry(final PhonebookEntry entry) throws RemoteException;
  
}
